Skip to content

fix(Textarea): should trigger keyboard event when set UseShiftEnter to false#5656

Merged
ArgoZhang merged 3 commits intomainfrom
refactor-textarea
Mar 19, 2025
Merged

fix(Textarea): should trigger keyboard event when set UseShiftEnter to false#5656
ArgoZhang merged 3 commits intomainfrom
refactor-textarea

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Mar 19, 2025

Link issues

fixes #5654

Summary By Copilot

This pull request includes updates to the BootstrapBlazor project version and a bug fix in the Textarea component's JavaScript file.

Version update:

Bug fix in Textarea component:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Fixes a bug in the Textarea component where the Enter key's default behavior was not prevented correctly when UseShiftEnter was set to false. Also, updates the project version to 9.5.0-beta04.

Bug Fixes:

  • Fixes the condition to prevent default behavior on Enter key press when shiftKey is pressed and useShiftEnter is true.

Chores:

  • Updates the project version to 9.5.0-beta04.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Mar 19, 2025

Reviewer's Guide by Sourcery

This pull request updates the project version and fixes a bug in the Textarea component's JavaScript file related to handling the Enter key when the UseShiftEnter property is set to false. The condition for preventing the default Enter key behavior has been corrected to ensure it only triggers when both the Shift key is pressed and UseShiftEnter is true.

Sequence diagram for Textarea Enter key handling

sequenceDiagram
    participant User
    participant Textarea

    User->>Textarea: Presses Enter key (e.key = 'Enter', shiftKey = true, useShiftEnter = true)
    Textarea->>Textarea: Check if (shiftKey && useShiftEnter)
    Textarea->>Textarea: Condition is true
    Textarea->>User: Default action prevented (e.preventDefault())

    User->>Textarea: Presses Enter key (e.key = 'Enter', shiftKey = false, useShiftEnter = true)
    Textarea->>Textarea: Check if (shiftKey && useShiftEnter)
    Textarea->>Textarea: Condition is false
    Textarea->>User: Default action not prevented

    User->>Textarea: Presses Enter key (e.key = 'Enter', shiftKey = true, useShiftEnter = false)
    Textarea->>Textarea: Check if (shiftKey && useShiftEnter)
    Textarea->>Textarea: Condition is false
    Textarea->>User: Default action not prevented
Loading

File-Level Changes

Change Details Files
Updated the project version.
  • Incremented the version from 9.5.0-beta03 to 9.5.0-beta04.
src/BootstrapBlazor/BootstrapBlazor.csproj
Corrected the condition to prevent default behavior on Enter key press based on shiftKey and useShiftEnter properties.
  • Modified the condition to if (shiftKey && useShiftEnter) to prevent default behavior only when both shiftKey is pressed and useShiftEnter is true.
src/BootstrapBlazor/Components/Textarea/Textarea.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5654 When UseShiftEnter is true, pressing Enter should not trigger the OnEnterAsync event.
#5654 When UseShiftEnter is true, pressing Shift+Enter should create a new line in the textarea.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added the bug Something isn't working label Mar 19, 2025
@bb-auto bb-auto Bot added this to the v9.4.0 milestone Mar 19, 2025
@ArgoZhang ArgoZhang merged commit 7921a8a into main Mar 19, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the refactor-textarea branch March 19, 2025 02:46
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The fix looks good, but it might be more readable to invert the conditional to avoid the double negative.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (08b8d60) to head (1bafd53).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5656   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          654       654           
  Lines        29576     29576           
  Branches      4208      4208           
=========================================
  Hits         29576     29576           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(Textarea): should trigger keyboard event when set UseShiftEnter to false

1 participant